Skip to content

EBL 3.0: SD-2812: Add "Cancel SI" option#609

Merged
HenrikHL merged 12 commits intomasterfrom
SD-2812_Add-Cancel-SI
Feb 9, 2026
Merged

EBL 3.0: SD-2812: Add "Cancel SI" option#609
HenrikHL merged 12 commits intomasterfrom
SD-2812_Add-Cancel-SI

Conversation

@HenrikHL
Copy link
Contributor

@HenrikHL HenrikHL commented Feb 9, 2026 •
edited
Loading

User description

SD-2812: Add the option to CANCEL a Shipping Instructions
Also fix a typo in descriptions

PR Type

Enhancement

Description

  • Extend cancel endpoint to support full Shipping Instructions cancellation

  • Add CANCELLED and DECLINED status values to Shipping Instructions

  • Update CancelShippingInstructionsUpdate schema with oneOf pattern

  • Clarify preconditions and postconditions for both cancel scenarios

  • Add example payloads for cancelling Shipping Instructions

Diagram Walkthrough

flowchart LR
  A["Cancel Endpoint"] -->|"UseCase 5"| B["Cancel Updated SI"]
  A -->|"UseCase 15"| C["Cancel Shipping Instructions"]
  B --> D["UPDATE_CANCELLED Status"]
  C --> E["CANCELLED Status"]
  F["New Statuses"] -->|"CANCELLED"| G["SI Schema"]
  F -->|"DECLINED"| G
Loading

File Walkthrough
Relevant files
Enhancement
EBL_v3.0.3.yaml
Extend cancel endpoint for full Shipping Instructions support

ebl/v3/EBL_v3.0.3.yaml

  • Extended PATCH /shipping-instructions/{documentReference} endpoint to
    support cancelling both Updated Shipping Instructions and full
    Shipping Instructions
  • Updated endpoint description to reference both UseCase 5 and UseCase
    15
  • Modified preconditions to specify different status requirements for
    each cancellation type
  • Refactored CancelShippingInstructionsUpdate schema using oneOf pattern
    to support both updatedShippingInstructionsStatus: UPDATE_CANCELLED
    and shippingInstructionsStatus: CANCELLED
  • Added CANCELLED and DECLINED status values to
    shippingInstructionsStatus enum in Shipping Instructions schema
  • Added example payloads demonstrating cancellation of full Shipping
    Instructions
  • Fixed typos in documentation (updatedShippingInstructionStatus →
    updatedShippingInstructionsStatus)
 +60/-18 
Configuration changes
styleguide.json
Styleguide configuration updates                                                 

.stoplight/styleguide.json

  • Minor configuration changes to styleguide
 +1/-1     

Loading
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

@pedrocarvalhodcsa pedrocarvalhodcsa pedrocarvalhodcsa approved these changes

@palatsangeetha palatsangeetha Awaiting requested review from palatsangeetha

Assignees

No one assigned

Labels

Review effort 3/5

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@HenrikHL @pedrocarvalhodcsa